BBS Toolkit

home *** CD-ROM | disk | FTP | other *** search

/ BBS Toolkit / BBS Toolkit.iso / rbbs_pc / rbbsdocs.zip / RBBSDOCS.6 < prev next >

Wrap

Text File | 1990-11-05 | 30KB | 560 lines

FILES RBBS-PC USES 6-1 6. FILES RBBS-PC USES --------------------- There are essentially two types of files that RBBS-PC uses -- "system" and "text" files. "System" files are defined as random files that RBBS-PC reads and writes to. "Text" files are defined as files that RBBS-PC primarily reads from. Text files can be edited externally to RBBS-PC with almost any text editor. Either type of file can be "static" or "variable" in length. By "static" it is meant that these files have a pre-defined length beyond which RBBS-PC does not extend them. Similarly, "variable" length files are defined as those files whose length is dynamically increased by RBBS-PC. (In some RBBS-PC environments, only the "static" length files can be shared SAFELY among multiple nodes.) The following table summarizes these files, using the default file names: "Static" Length Files "Variable" Length Files MESSAGES (can be variable) CALLERS ARCWORK?.DEF USERS COMMENTS NODE?WRK MESSAGES.BAK DOUT?.DEF RBBS?F1.DEF USERS.BAK DK*.ARC DORINFO?.DEF RBBS?PC.DEF DRST?.DEF 99.DIR (upload directory) The following "text files" are "static" in length and can be shared safely: NEWUSER RBBS-CDR.DEF MENU0 --> MENUA LG*.DEF BULLET, BULLET1 --> BULLET? AUTOPAGE.DEF DIR.DIR, aa.DIR --> bb.DIR CONFMAIL.DEF CDR.CDR, aa.CDR --> bb.CDR RBBS-CDR.DEF FILESEC PROTO.DEF CONFENCE RBBS-REG.DEF *.PUI PRELOG.DEF PASSWRDS EPILOG.DEF *.HLP PRIV.DEF HELP?? AUTOPAGE.DEF TRASHCAN RBBS?TM.DEF WELCOME MAIN.NWS In a CORVUS OmniNet network environment any of the "static" length files can be shared on a common volume and ALL of the "variable" length files must be segregated on volumes unique to each copy of RBBS-PC. RBBS-PC uses a RENAME function in order to determine if a file exists. Because of this, all the volumes accessed by any RBBS-PC in a CORVUS network must be designated "read/write." Therefore, you must be very careful when running CONFIG. CONFIG creates the definition file (RBBS?PC.DEF) for each copy of RBBS-PC. See Appendix L for information regarding Corvus OmniNet). The one file that cannot be shared is the Caller's file. RBBS-PC continually logs to it and the activity of multiple users would get mixed together. LOCKED FILE STATUS DISPLAY RBBS-PC displays the status of those files which must be locked in a network environment on line 25. The lock status of the message file is displayed in positions 68 & 69. The lock status of the user file is displayed in positions 71 & 72. The lock block status is displayed in positions 74 & 75 and comments/uploads share positions 77 & 78. The letter RBBS-PC 17.3A TECHNICAL REFERENCE MANUAL 6-2 "U" in the first position shows that the file is currently "UNLOCKED". The letter "L" in the first position indicates that the file is "LOCKED". 6.1 RBBS-PC Directory Structure ------------------------------- The RBBS-PC package contains many files, which can be put nearly anywhere the SysOp desires. However, to avoid confusion, the default locations for the RBBS-PC release files are grouped logically into subdirectories. If the files are not placed in the proper subdirectory, RBBS-PC will behave erratically until you reconfigure the file locations with CONFIG. The directory is as follows: DEFAULT DIRECTORY (usually C:\RBBS) Contains RBBS-PC program, message and user files, INSTALL files and operational .BAT files. BULLETIN DIRECTORY (usually, C:\RBBS\BULLET) Contains the RBBS-PC bulletins and bulletin menu files. FILE CATALOG DIRECTORY (usually C:\RBBS\DIR) Contains the files needed to maintain the list of files available for download. DOC DIRECTORY (usually, C:\RBBS\DOC) Contains the RBBS-PC documentation. FILE DIRECTORY (usually, C:\RBBS\FILES) Contains the files available to download. Each SysOp will want to expand this into a group of directories. Uploads may also be placed in this directory. HELP DIRECTORY (usually, C:\RBBS\HELP) Contains all online HELP files for RBBS-PC, including help files created by the SysOp. FEATURE REMOVAL DIRECTORY (usually, C:\RBBS\LIT) Contains utilities for removing features from RBBS-PC in order to reduce executable code size. MACRO DIRECTORY (usually, C:\RBBS\MACROS) Contains the MACRO files which allow the SysOp to design custom RBBS-PC commands. NODE DIRECTORY (usually, C:\RBBS\NODE1) Contains the files specific to each "node" of RBBS-PC. A multi- node system will have several "node" subdirectories. Files in this subdirectory include CALLER log files, RCTTY.BAT door interface files, and timed-event semaphore files. PERSONAL DOWNLOAD DIRECTORY (usually, C:\RBBS\PRIVATE) Contains the directory file for RBBS-PC's personal download feature. QUESTIONNAIRE DIRECTORY (usually, C:\RBBS\QUESTION) Contains the RBBS-PC questionnaire files. SMALL EXECUTABLE DIRECTORY (usually, C:\RBBS\SMF) Contains a substitute RBBS-PC.EXE which has reduced error- reporting, resulting in a smaller executable file. FILES RBBS-PC USES 6-3 SOURCE CODE DIRECTORY (usually, C:\RBBS\SOURCE) Contains source code and .BAT files for recompiling RBBS-PC. SYSTEM DIRECTORY (usually, C:\RBBS\SYSTEM) Contains configuration files used to customize RBBS-PC, such as the PASSWRDS, FILESEC, CONFMAIL and DOORS.DEF files. TEXT DIRECTORY (usually, C:\RBBS\TEXT) Contains text files seen by the callers, including MENU files, WELCOME, PRELOG and LG*.DEF. UTILITY DIRECTORY (usually, C:\RBBS\UTIL) Contains several utilities for maintaining your RBBS-PC. XFER DIRECTORY (usually, C:\RBBS\XFER) Contains the files necessary to operate file transfer protocols, including PROTO.DEF, and various protocol drivers. Before moving any of these files, be sure you are familiar with the CONFIG utility. If RBBS-PC cannot find a required file, the results are UNPREDICTABLE! The default directory structure is only offered as a guide. Each SysOp is encouraged to arrange files in a way that suits the SysOp's taste. 6.2 RBBS-PC System Files ------------------------ As shown above, "system" files are both static and variable in length. The system files used by RBBS-PC are: MESSAGES Often named MAINM.DEF. This file is a random file that contains the message text for the RBBS-PC system, and several special records (e.g. checkpoint and node records). The first record in the file contains the RBBS-PC "checkpoint" record. The records immediately following this first record are the RBBS-PC "node" records. From there, the rest of the file consists of message header records which are followed by the actual message text. Appendix A describes these records, the fields within them, and how each field is used. RBBS-PC expects the MESSAGES file to exist, and to be in the proper format (CONFIG should be used to create this file). When it loads, if CONFIG does not find the MESSAGES file, or it finds one in pre-12.3A format, CONFIG will create it and initialize it to the size the SysOp has specified. Because of the special fixed length records in this file, it should not be created or edited outside CONFIG. When the SysOp "packs" the message file using CONFIG, the current message file is preserved as MESSAGES.BAK, in case the "pack" is unsuccessful (i.e. not enough space to duplicate the message file). If the disk fills up during the pack function, RBBS-PC can recover the message file using MESSAGES.BAK. When the message file is successfully packed, the original MESSAGES file is renamed MESSAGES.OLD, and MESSAGES.BAK is renamed MESSAGES. CONFIG will ask whether you want to delete the old MESSAGES file. (Note that, in a multiple RBBS-PC environment, the message file should only be "packed" when none of the nodes are running.) The MESSAGES file can be shared among multiple RBBS-PCs. RBBS-PC 17.3A TECHNICAL REFERENCE MANUAL 6-4 USERS Often named MAINU.DEF. The USERS file is a random access file that has a record for each user of the system. The record contains a profile for each user who has logged onto RBBS-PC. Appendix A describes the format of the records within the USERS file. These records are 128 bytes in length and are automatically maintained by RBBS-PC. The SysOp can do some limited editing using SysOp Function 5. RBBS-PC expects the USERS file to exist, and to be in the proper format (as the with MESSAGES file, CONFIG should be used to create this file). If CONFIG does not find the USERS file on the system when it loads, it will create it to the size specified by the SysOp. The USERS file should not be created or edited outside CONFIG (with the exception of certain utilities specifically designed for this task -- under NO circumstances use a text editor to edit the USERS file). When the SysOp "packs" the user file using CONFIG, the current USERS file is preserved as USERS.BAK, in case the "pack" is unsuccessful (i.e. not enough space to duplicate the users file). If the disk fills up during the pack function RBBS-PC will recover the USERS file from USERS.BAK. When the users file is successfully packed, the original users file is renamed USERS.OLD and the temporary file USERS.BAK is renamed USERS. CONFIG will ask whether you want to delete the old USERS file or not. (Note that in a multiple RBBS-PC environment, the USERS file should only be "packed" when none of the nodes are running.) The USERS file can be shared among multiple RBBS-PC's. CALLERS This file is a random file that contains a log of all your caller's activities as they use the system. This is an ASCII file, but it is formatted as 64 byte fixed length records with no carriage returns or line feeds between the records. If you set the "extended logging" feature of RBBS-PC to be on, then a more detailed record of each caller's activity will be kept. There are many "statistic" and "bulletin" generating utilities which have been written to work with the CALLERS file. If the CALLERS file is not found, RBBS-PC will create a new one (no need for CONFIG here). To clear the log, ERASE the file. The CALLERS file can't be shared among multiple nodes, because activity from the various nodes would be mingled together in the file, making it impossible to determine who did what, and when. ARCWORK?.DEF This file is created as output by the file view command and contains the contents of the archived file being inquired against. The node number replaces the wildcard "?". BULLET.FCK This file is used to find new bulletins when NAMED bulletins (rather than numbered bulletins) are used. It should contain a list of NAMED bulletin file names, one per line. Numbered bulletins are automatically checked by RBBS-PC. COMMENTS This file is a sequential file that contains any comments that have been left by users for the SysOp. The file can be scanned by a SysOp function, or it can be TYPEd or edited outside the RBBS-PC system. A SysOp function is available to delete this file. The file will be created by RBBS-PC if it is not found. The COMMENTS file cannot be shared among FILES RBBS-PC USES 6-5 multiple RBBS-PC's using CORVUS' "OMNINET", but can be shared using other multi-user systems. Please note that if you have activated the CONFIG parameter which tells RBBS-PC to store Comments to the SysOp as privates messages to the SysOp, then this file will not be used. DK*.ARC These files are created as output by the Library Sub-System archive program. These work files are deleted each time RBBS-PC recycles. DOORS.DEF This is the "doors control file" used by RBBS-PC to allow the SysOp more control over access to doors. See section 14.3. DORINFO?.DEF This file is created by RBBS-PC when a caller exits to a DOOR. It contains information about the caller needed by a "DOOR" (see section 14.2.2). DOUT?.DEF Used by doors to communicate back to RBBS-PC. DRST?.DEF Internal file used by RBBS-PC to restore itself upon return from doors. NODE?WRK This file is created by RBBS-PC when a caller exits to an external protocol to do "batch" downloads. It contains a list of fully qualified file names to be downloaded. QMXFER.ERR This file is created as output by QMXFER.COM to notify RBBS-PC of the results of an external file protocol transfer. RBBS?F1.DEF This is the file dynamically created when the local SysOp exits to DOS. RBBS?PC.DEF This is an ASCII text file created as output by the CONFIG program. It contains the configuration parameters for RBBS-PC. Each time RBBS-PC is run, it reads from this file. In a multiple RBBS-PC environment, the node definition file for each RBBS-PC is named RBBSxPC.DEF (where "x" is a number 1 to 9, 0 meaning the tenth node, and A through Z for the 11th through the 36th node). In a single user RBBS-PC environment, the name will be RBBS-PC.DEF. While this file CAN be edited with text editor, and many experienced RBBS-PC SysOps do this, you might have difficulty determining which parameter is which and how the various parameters work together. Unless you are QUITE SURE of what you are doing, we recommend that you use CONFIG to alter your RBBS-PC.DEF files. 99.DIR The is the default filename for the file RBBS-PC builds to hold the name, file size, date, and description appended to it of files that have been uploaded. The 99.DIR file cannot be shared among multiple RBBS-PC's using CORVUS's "OMNINET", but can be shared on other multi-user systems. RBBS-PC 17.3A TECHNICAL REFERENCE MANUAL 6-6 6.3 RBBS-PC's Graphics Support ------------------------------ RBBS-PC can display three different "flavors" of text files: - Non-graphic text, consisting of the 128 ASCII characters - Graphic text, consisting of the 256-character IBM character set - ANSI color graphics, which include ANSI terminal commands to display color, position text on the screen, and play music. The "flavor" seen is based on the user's current graphics option (which can be changed with the Graphics command on the Utility menu). In order for a user to see either Graphics or ANSI color, the following items must have occurred: - The caller must have logged on with 8 bit word, no parity, and 1 stop bit. - The caller must have selected graphics (either "ASCII" or "Color-IBM"), and the file must exist with a filename ending in either: "G" For Graphic files, or "C" For ANSI Color files - The caller's hardware and software must support the "flavor" selected. All IBM PCs and compatibles support Graphics, and most will support ANSI Color, if the right device driver is loaded on the caller's system. RBBS-PC will check to see if a "graphics" file exists by appending a "G" or "C" to the file name (e.g. MAINC.NWS instead of MAIN.NWS). If such a file can't be found, RBBS-PC will check to see if a non-graphics file exists (i.e. one without the "G" or "C"). RBBS-PC will display the first file it finds. 6.4 RBBS-PC Text Files ---------------------- The RBBS-PC "text" files are both static and variable in length. The "text" files used by RBBS-PC are: AUTOPAGE.DEF This is a text file setup by the SysOp that informs RBBS-PC of which caller, callers, or group of callers that the system should automatically "page" the SysOp as soon as they log on. See section 7.11. BULLET This is a text menu file that describes the BULLETINS available on RBBS-PC. It is displayed following the WELCOME file when a user first enters the system. It must be present if CONFIG parameter 43 is greater than 1. It can also be called from the main menu with the B)ulletins command. BULLET1 --> BULLET99 There can be 1 to 99 numbered "bulletins", and virtually unlimited named bulletins. RBBS-PC will check for the existence of a file whose name consists of the prefix given by parameter 44 of CONFIG appended with the bulletin number and using parameter 41 of CONFIG to determine the drive to find the bulletin on. CONFENCE Displayed to users who issue the J)oin function from the main menu. It can be created by any text editor that can FILES RBBS-PC USES 6-7 create an ASCII file and should contain a list of the available conferences. CONFMAIL.DEF This is a text file setup by the SysOp to notify callers of the mail they have waiting in specific (or all) conferences. See section 18. DIR.DIR, *.DIR The DIR.DIR file, which can be renamed using the CONFIG utility, is a text file which contains a listing of all the categories in your FMS.DIR (FMS = File Management System, see section 12). Each of these categories has to be linked, via a code, to the entries in the FMS.DIR file, and this is done via the DIR.CAT file. If you are NOT using FMS-style directories, but rather want your file catalogs to be normal ASCII text files, then you need to create a separate file for each category listed in DIR.DIR. Each listing will be in a file *.DIR, where the wildcard "*" is the category code from DIR.DIR. The DIR.DIR file is not optional, since whether you're using FMS-style directories or not, you still need to present your list of categories to the caller. Using FMS-style directories allows you to keep all the downloadable files listed in one big file (or several smaller ones), and use category "codes" within that file to group them. Without FMS, each category code has to be its own "directory". DIR.CDR, *.CDR At least one DIR.CDR file has to be present on one of the drives available for downloading if the Library Sub-System support has been activated. Alternative directories, *.CDR should be reflected in the DIR.CDR file. EPILOG.DEF This is the default name for the questionnaire that is shown to users as they log off. It can be either an extensive "poll" (which frequent users would find tedious) or a simple thank you. Or, you omit this file entirely. FILESEC This file controls which security levels can download from which paths, and it is more fully described in section 15.4. HELP There is a help file for each command which has the format xy.HLP, where x is the first letter of the section (M,F,U) and y is the command letter, except for global and SysOp commands, which have the format y.HLP. There are also the following special help files: HELP03 Describes the message protection options when <?> is entered after the message <E>nter command is executed at the main message menu. HELP04 Describes the message entry subfunctions when <?> is entered at the subfunction prompt. HELP07 Describes the message read options when <?> is entered while reading messages. HELP09 Displayed when <H>elp is requested for the type of graphics a user wants (none, ASCII, color/music). RBBS-PC 17.3A TECHNICAL REFERENCE MANUAL 6-8 FILE.HLP Displayed when <H>elp is entered in the files subsystem function prompt. LIBR.HLP Displayed when <H>elp is entered within the library subsystem. MAIN.HLP Displayed when <H>elp is requested on the main function prompt. It contains command information. RGXPIRD.HLP Displayed to users when their registration has expired. See section 9. RGXPIRE.HLP Displayed to users when their registration is about to expire. See section 9. SECVIO.HLP If this file is present, it is shown to the caller each time a security violation occurs. SMARTTXT.HLP Illustrates the use of embedded commands within any text file displayed by RBBS-PC that causes the text to appear personalized to the caller. See section 7.9 for a more complete description of this feature. UPCAT.HLP Used to help users categorize their uploads. UTIL.HLP Displayed when <H>elp is requested in the utility subsystem function prompt. LG*.DEF This is the file displayed, if present, to users based on security level when the caller logs on. The wildcard "*" is the security level of the users who would see this file. For instance, this allows the SysOp to provide an explanation for callers whose security level falls below the minimum to log on, or it can also be used to provide a "personalized" welcome to users who have a specific security level. Some examples are: ┌─────────┬────────────┬──────────────────────────────────────────────────┐ │Security │ File name │ Sample text for level greeting file │ │ Level │ │ │ ├─────────┼────────────┼──────────────────────────────────────────────────┤ │ 9 │ LG9.DEF │ "Hi, nice to have another SysOp call in." │ ├─────────┼────────────┼──────────────────────────────────────────────────┤ │ 6 │ LG6.DEF │ "Registered users are the most appreciated." │ ├─────────┼────────────┼──────────────────────────────────────────────────┤ │ 4 │ LG4.DEF │ "Too many security violations." │ ├─────────┼────────────┼──────────────────────────────────────────────────┤ │ -1 │ LG-1.DEF │ "Your behavior has been inappropriate." │ ├─────────┼────────────┼──────────────────────────────────────────────────┤ │ -9999 │LG-9999.DEF │ Special "BBS verification" message for the U.S. │ │ │ │ BBS listing (Appendix B). │ └─────────┴────────────┴──────────────────────────────────────────────────┘ MAIN.NWS The "news" file for the main message base. If you rename your users and messages to XYZU.DEF and XYZM.DEF, then "XYZ.NWS" would be the news file. See section 7.13. FILES RBBS-PC USES 6-9 MAIN.PUI This is the programmable user interface file that allows the SysOp to structure the RBBS-PC commands as desired. See section 7.6 for a description of the PUI. MENU* These contain the local SysOp menu and menu of various commands for the subsystems. NEWUSER This is a text file that is displayed for new users just before registration occurs. PASSWRDS This file controls which security levels get which privileges, and is more fully described in section 15.3. PRELOG Displayed to callers prior to asking for their first/last name and password. PRIV.DEF This file contains the information used for "personal downloading", described in section 12.7. RBBS-CDR.DEF A text file that contains the disk numbers, paths and disk titles of disks available to the Library subsystem. The format of the file is described in section 12.6. The RBBS-CDR.DEF (and matching FMS directory) file can be downloaded from Doug Azzarito's BBS. It is not distributed with RBBS-PC because of it's size (500K). RBBS-REG.DEF This is the default name for the questionnaire that is asked of all new users who log on. The "new user" questionnaire is only seen once, by new users. This file is optional. TRASHCAN A text file that contains names that the SysOp finds objectionable and does not want used as either a users first or last name. RBBS-PC uses this file, if it exists, to deny access to anyone using one of these names for either their first or last name. WELCOME A text file that a user first sees upon logging onto the system. Similarly each "conference" can have a "welcome" file by having a file whose last character ended in a "w" (i.e. conference "RBBS" would have a message file named RBBSM.DEF and a user file named RBBSU.DEF if it where a "private" conference and a welcome file named RBBSW.DEF).